Neon Strikers - Code README

This README explains the structure of the Code directory for the Neon Strikers project.

------------------------------------------------------------
CODE DIRECTORY STRUCTURE
------------------------------------------------------------

Code/
|
├── README.txt
|   This file. Explains the contents and structure of the Code directory.
|
├── Source/
|   Contains the complete Unity project source code.
|
|   Source/neon-strikers/
|   ├── Assets/
|   |   Contains all game assets, including scenes, scripts, sprites, UI images,
|   |   audio files, prefabs, materials, physics settings, and animations.
|   |
|   ├── Packages/
|   |   Contains Unity package dependency information required by the project.
|   |
|   ├── ProjectSettings/
|   |   Contains Unity project configuration files, including build settings,
|   |   physics settings, rendering settings, input settings, and editor settings.
|   |
|   ├── README.md
|   |   Project-level Unity README file.
|   |
|   ├── LICENSE
|   |   License file for the repository.
|   |
|   └── .gitignore
|       Git ignore rules for Unity-generated files.
|
├── Build/
|   Contains the deployable version of the game.
|
|   Build/NeonStrikersBuild.app
|   macOS executable build of the game.
|
├── InstallationGuide.pdf
|   Step-by-step installation and setup instructions for opening, running,
|   and building the project.
|
└── UserManual.pdf
    Instructions for using the system, including controls, gameplay flow,
    and major features.

------------------------------------------------------------
SOURCE CODE DESCRIPTION
------------------------------------------------------------

The Unity source project is located in:

Code/Source/neon-strikers/

The main source folders are:

Assets/Scenes/
- Main Menu
- Arena_01
- Arena_02
- Arena_03
- Results

Assets/Scripts/
- Gameplay scripts such as GameManager, GoalZone, MatchData, ResultsManager,
  and SceneLoader
- Player scripts such as PlayerMovement, PlayerKick, PlayerLoseEffects,
  PlayerLoseLaunch, and PulseEffect
- Ball script such as BallController
- UI scripts such as LogoPulse, UIButtonHover, and button-related scripts
- Utility scripts for portals, slow zones, cooldowns, and goal effects

Assets/Audio/
- Background music and gameplay sound effects

Assets/Art/
- Game sprites, menu backgrounds, results backgrounds, ghost asset, UI art,
  and visual elements

Assets/Prefabs/
- Reusable Unity prefabs such as player objects, effects, and gameplay objects

------------------------------------------------------------
DEPLOYABLE CODE
------------------------------------------------------------

The deployable macOS build is located in:

Code/Build/NeonStrikersBuild.app

To run the deployable build on macOS:
1. Open the Code/Build folder.
2. Double-click NeonStrikers.app.
3. If macOS blocks the app, right-click NeonStrikers.app and select Open.

------------------------------------------------------------
UNITY VERSION
------------------------------------------------------------

Unity Editor Version:
6000.4.0f1

------------------------------------------------------------
SCENE ORDER
------------------------------------------------------------

The final scene order for the project is:

1. Main Menu
2. Arena_01
3. Arena_02
4. Arena_03
5. Results

The older Game scene is deprecated and is not used in the final version.

------------------------------------------------------------
INSTALLATION GUIDE AND USER MANUAL
------------------------------------------------------------

The Code directory also includes:

InstallationGuide.pdf
- Explains how to open the Unity project
- Explains how to run the project in Unity
- Explains how to build the project
- Includes environment setup notes

UserManual.pdf
- Explains how to play Neon Strikers
- Lists player controls
- Describes gameplay features
- Explains the game flow and results screen

------------------------------------------------------------
EXCLUDED UNITY-GENERATED FOLDERS
------------------------------------------------------------

The following Unity-generated folders are intentionally excluded from the
source submission because Unity regenerates them automatically:

- Library/
- Temp/
- Logs/
- UserSettings/
------------------------------------------------------------
------------------------------------------------------------